4 * HTML form generation and submission handling.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\ObjectFactory
;
27 * Object handling generic submission, CSRF protection, layout and
28 * other logic for UI forms. in a reusable manner.
30 * In order to generate the form, the HTMLForm object takes an array
31 * structure detailing the form fields available. Each element of the
32 * array is a basic property-list, including the type of field, the
33 * label it is to be given in the form, callbacks for validation and
34 * 'filtering', and other pertinent information.
36 * Field types are implemented as subclasses of the generic HTMLFormField
37 * object, and typically implement at least getInputHTML, which generates
38 * the HTML for the input field to be placed in the table.
40 * You can find extensive documentation on the www.mediawiki.org wiki:
41 * - https://www.mediawiki.org/wiki/HTMLForm
42 * - https://www.mediawiki.org/wiki/HTMLForm/tutorial
44 * The constructor input is an associative array of $fieldname => $info,
45 * where $info is an Associative Array with any of the following:
47 * 'class' -- the subclass of HTMLFormField that will be used
48 * to create the object. *NOT* the CSS class!
49 * 'type' -- roughly translates into the <select> type attribute.
50 * if 'class' is not specified, this is used as a map
51 * through HTMLForm::$typeMappings to get the class name.
52 * 'default' -- default value when the form is displayed
53 * 'nodata' -- if set (to any value, which casts to true), the data
54 * for this field will not be loaded from the actual request. Instead,
55 * always the default data is set as the value of this field.
56 * 'id' -- HTML id attribute
57 * 'cssclass' -- CSS class
58 * 'csshelpclass' -- CSS class used to style help text
59 * 'dir' -- Direction of the element.
60 * 'options' -- associative array mapping raw text labels to values.
61 * Some field types support multi-level arrays.
62 * Overwrites 'options-message'.
63 * 'options-messages' -- associative array mapping message keys to values.
64 * Some field types support multi-level arrays.
65 * Overwrites 'options' and 'options-message'.
66 * 'options-message' -- message key or object to be parsed to extract the list of
67 * options (like 'ipbreason-dropdown').
68 * 'label-message' -- message key or object for a message to use as the label.
69 * can be an array of msg key and then parameters to
71 * 'label' -- alternatively, a raw text message. Overridden by
73 * 'help' -- message text for a message to use as a help text.
74 * 'help-message' -- message key or object for a message to use as a help text.
75 * can be an array of msg key and then parameters to
77 * Overwrites 'help-messages' and 'help'.
78 * 'help-messages' -- array of message keys/objects. As above, each item can
79 * be an array of msg key and then parameters.
81 * 'help-inline' -- Whether help text (defined using options above) will be shown
82 * inline after the input field, rather than in a popup.
83 * Defaults to true. Only used by OOUI form fields.
84 * 'required' -- passed through to the object, indicating that it
85 * is a required field.
86 * 'size' -- the length of text fields
87 * 'filter-callback' -- a function name to give you the chance to
88 * massage the inputted value before it's processed.
89 * @see HTMLFormField::filter()
90 * 'validation-callback' -- a function name to give you the chance
91 * to impose extra validation on the field input.
92 * @see HTMLFormField::validate()
93 * 'name' -- By default, the 'name' attribute of the input field
94 * is "wp{$fieldname}". If you want a different name
95 * (eg one without the "wp" prefix), specify it here and
96 * it will be used without modification.
97 * 'hide-if' -- expression given as an array stating when the field
98 * should be hidden. The first array value has to be the
99 * expression's logic operator. Supported expressions:
101 * [ 'NOT', array $expression ]
102 * To hide a field if a given expression is not true.
104 * [ '===', string $fieldName, string $value ]
105 * To hide a field if another field identified by
106 * $field has the value $value.
108 * [ '!==', string $fieldName, string $value ]
109 * Same as [ 'NOT', [ '===', $fieldName, $value ]
110 * 'OR', 'AND', 'NOR', 'NAND'
111 * [ 'XXX', array $expression1, ..., array $expressionN ]
112 * To hide a field if one or more (OR), all (AND),
113 * neither (NOR) or not all (NAND) given expressions
114 * are evaluated as true.
115 * The expressions will be given to a JavaScript frontend
116 * module which will continually update the field's
119 * Since 1.20, you can chain mutators to ease the form generation:
122 * $form = new HTMLForm( $someFields );
123 * $form->setMethod( 'get' )
124 * ->setWrapperLegendMsg( 'message-key' )
126 * ->displayForm( '' );
128 * Note that you will have prepareForm and displayForm at the end. Other
129 * methods call done after that would simply not be part of the form :(
131 * @todo Document 'section' / 'subsection' stuff
133 class HTMLForm
extends ContextSource
{
134 // A mapping of 'type' inputs onto standard HTMLFormField subclasses
135 public static $typeMappings = [
136 'api' => HTMLApiField
::class,
137 'text' => HTMLTextField
::class,
138 'textwithbutton' => HTMLTextFieldWithButton
::class,
139 'textarea' => HTMLTextAreaField
::class,
140 'select' => HTMLSelectField
::class,
141 'combobox' => HTMLComboboxField
::class,
142 'radio' => HTMLRadioField
::class,
143 'multiselect' => HTMLMultiSelectField
::class,
144 'limitselect' => HTMLSelectLimitField
::class,
145 'check' => HTMLCheckField
::class,
146 'toggle' => HTMLCheckField
::class,
147 'int' => HTMLIntField
::class,
148 'float' => HTMLFloatField
::class,
149 'info' => HTMLInfoField
::class,
150 'selectorother' => HTMLSelectOrOtherField
::class,
151 'selectandother' => HTMLSelectAndOtherField
::class,
152 'namespaceselect' => HTMLSelectNamespace
::class,
153 'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton
::class,
154 'tagfilter' => HTMLTagFilter
::class,
155 'sizefilter' => HTMLSizeFilterField
::class,
156 'submit' => HTMLSubmitField
::class,
157 'hidden' => HTMLHiddenField
::class,
158 'edittools' => HTMLEditTools
::class,
159 'checkmatrix' => HTMLCheckMatrix
::class,
160 'cloner' => HTMLFormFieldCloner
::class,
161 'autocompleteselect' => HTMLAutoCompleteSelectField
::class,
162 'language' => HTMLSelectLanguageField
::class,
163 'date' => HTMLDateTimeField
::class,
164 'time' => HTMLDateTimeField
::class,
165 'datetime' => HTMLDateTimeField
::class,
166 'expiry' => HTMLExpiryField
::class,
167 // HTMLTextField will output the correct type="" attribute automagically.
168 // There are about four zillion other HTML5 input types, like range, but
169 // we don't use those at the moment, so no point in adding all of them.
170 'email' => HTMLTextField
::class,
171 'password' => HTMLTextField
::class,
172 'url' => HTMLTextField
::class,
173 'title' => HTMLTitleTextField
::class,
174 'user' => HTMLUserTextField
::class,
175 'usersmultiselect' => HTMLUsersMultiselectField
::class,
176 'titlesmultiselect' => HTMLTitlesMultiselectField
::class,
177 'namespacesmultiselect' => HTMLNamespacesMultiselectField
::class,
182 protected $mMessagePrefix;
184 /** @var HTMLFormField[] */
185 protected $mFlatFields;
187 protected $mFieldTree;
188 protected $mShowReset = false;
189 protected $mShowSubmit = true;
190 protected $mSubmitFlags = [ 'primary', 'progressive' ];
191 protected $mShowCancel = false;
192 protected $mCancelTarget;
194 protected $mSubmitCallback;
195 protected $mValidationErrorMessage;
197 protected $mPre = '';
198 protected $mHeader = '';
199 protected $mFooter = '';
200 protected $mSectionHeaders = [];
201 protected $mSectionFooters = [];
202 protected $mPost = '';
205 protected $mTableId = '';
207 protected $mSubmitID;
208 protected $mSubmitName;
209 protected $mSubmitText;
210 protected $mSubmitTooltip;
212 protected $mFormIdentifier;
214 protected $mMethod = 'post';
215 protected $mWasSubmitted = false;
218 * Form action URL. false means we will use the URL to set Title
222 protected $mAction = false;
225 * Form attribute autocomplete. A typical value is "off". null does not set the attribute
229 protected $mAutocomplete = null;
231 protected $mUseMultipart = false;
232 protected $mHiddenFields = [];
233 protected $mButtons = [];
235 protected $mWrapperLegend = false;
238 * Salt for the edit token.
241 protected $mTokenSalt = '';
244 * If true, sections that contain both fields and subsections will
245 * render their subsections before their fields.
247 * Subclasses may set this to false to render subsections after fields
250 protected $mSubSectionBeforeFields = true;
253 * Format in which to display form. For viable options,
254 * @see $availableDisplayFormats
257 protected $displayFormat = 'table';
260 * Available formats in which to display the form
263 protected $availableDisplayFormats = [
271 * Available formats in which to display the form
274 protected $availableSubclassDisplayFormats = [
280 * Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
282 * @param string $displayFormat
283 * @param mixed $arguments,... Additional arguments to pass to the constructor.
286 public static function factory( $displayFormat/*, $arguments...*/ ) {
287 $arguments = func_get_args();
288 array_shift( $arguments );
290 switch ( $displayFormat ) {
292 return ObjectFactory
::constructClassInstance( VFormHTMLForm
::class, $arguments );
294 return ObjectFactory
::constructClassInstance( OOUIHTMLForm
::class, $arguments );
296 /** @var HTMLForm $form */
297 $form = ObjectFactory
::constructClassInstance( self
::class, $arguments );
298 $form->setDisplayFormat( $displayFormat );
304 * Build a new HTMLForm from an array of field attributes
306 * @param array $descriptor Array of Field constructs, as described above
307 * @param IContextSource|null $context Available since 1.18, will become compulsory in 1.18.
308 * Obviates the need to call $form->setTitle()
309 * @param string $messagePrefix A prefix to go in front of default messages
311 public function __construct( $descriptor, /*IContextSource*/ $context = null,
314 if ( $context instanceof IContextSource
) {
315 $this->setContext( $context );
316 $this->mTitle
= false; // We don't need them to set a title
317 $this->mMessagePrefix
= $messagePrefix;
318 } elseif ( $context === null && $messagePrefix !== '' ) {
319 $this->mMessagePrefix
= $messagePrefix;
320 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
322 // it's actually $messagePrefix
323 $this->mMessagePrefix
= $context;
326 // Evil hack for mobile :(
328 !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
329 && $this->displayFormat
=== 'table'
331 $this->displayFormat
= 'div';
334 // Expand out into a tree.
335 $loadedDescriptor = [];
336 $this->mFlatFields
= [];
338 foreach ( $descriptor as $fieldname => $info ) {
339 $section = $info['section'] ??
'';
341 if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
342 $this->mUseMultipart
= true;
345 $field = static::loadInputFromParameters( $fieldname, $info, $this );
347 $setSection =& $loadedDescriptor;
349 foreach ( explode( '/', $section ) as $newName ) {
350 if ( !isset( $setSection[$newName] ) ) {
351 $setSection[$newName] = [];
354 $setSection =& $setSection[$newName];
358 $setSection[$fieldname] = $field;
359 $this->mFlatFields
[$fieldname] = $field;
362 $this->mFieldTree
= $loadedDescriptor;
366 * @param string $fieldname
369 public function hasField( $fieldname ) {
370 return isset( $this->mFlatFields
[$fieldname] );
374 * @param string $fieldname
375 * @return HTMLFormField
376 * @throws DomainException on invalid field name
378 public function getField( $fieldname ) {
379 if ( !$this->hasField( $fieldname ) ) {
380 throw new DomainException( __METHOD__
. ': no field named ' . $fieldname );
382 return $this->mFlatFields
[$fieldname];
386 * Set format in which to display the form
388 * @param string $format The name of the format to use, must be one of
389 * $this->availableDisplayFormats
391 * @throws MWException
393 * @return HTMLForm $this for chaining calls (since 1.20)
395 public function setDisplayFormat( $format ) {
397 in_array( $format, $this->availableSubclassDisplayFormats
, true ) ||
398 in_array( $this->displayFormat
, $this->availableSubclassDisplayFormats
, true )
400 throw new MWException( 'Cannot change display format after creation, ' .
401 'use HTMLForm::factory() instead' );
404 if ( !in_array( $format, $this->availableDisplayFormats
, true ) ) {
405 throw new MWException( 'Display format must be one of ' .
408 $this->availableDisplayFormats
,
409 $this->availableSubclassDisplayFormats
415 // Evil hack for mobile :(
416 if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
420 $this->displayFormat
= $format;
426 * Getter for displayFormat
430 public function getDisplayFormat() {
431 return $this->displayFormat
;
435 * Get the HTMLFormField subclass for this descriptor.
437 * The descriptor can be passed either 'class' which is the name of
438 * a HTMLFormField subclass, or a shorter 'type' which is an alias.
439 * This makes sure the 'class' is always set, and also is returned by
440 * this function for ease.
444 * @param string $fieldname Name of the field
445 * @param array &$descriptor Input Descriptor, as described above
447 * @throws MWException
448 * @return string Name of a HTMLFormField subclass
450 public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
451 if ( isset( $descriptor['class'] ) ) {
452 $class = $descriptor['class'];
453 } elseif ( isset( $descriptor['type'] ) ) {
454 $class = static::$typeMappings[$descriptor['type']];
455 $descriptor['class'] = $class;
461 throw new MWException( "Descriptor with no class for $fieldname: "
462 . print_r( $descriptor, true ) );
469 * Initialise a new Object for the field
471 * @param string $fieldname Name of the field
472 * @param array $descriptor Input Descriptor, as described above
473 * @param HTMLForm|null $parent Parent instance of HTMLForm
475 * @throws MWException
476 * @return HTMLFormField Instance of a subclass of HTMLFormField
478 public static function loadInputFromParameters( $fieldname, $descriptor,
479 HTMLForm
$parent = null
481 $class = static::getClassFromDescriptor( $fieldname, $descriptor );
483 $descriptor['fieldname'] = $fieldname;
485 $descriptor['parent'] = $parent;
488 # @todo This will throw a fatal error whenever someone try to use
489 # 'class' to feed a CSS class instead of 'cssclass'. Would be
490 # great to avoid the fatal error and show a nice error.
491 return new $class( $descriptor );
495 * Prepare form for submission.
497 * @warning When doing method chaining, that should be the very last
498 * method call before displayForm().
500 * @throws MWException
501 * @return HTMLForm $this for chaining calls (since 1.20)
503 public function prepareForm() {
504 # Check if we have the info we need
505 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
506 throw new MWException( 'You must call setTitle() on an HTMLForm' );
509 # Load data from the request.
511 $this->mFormIdentifier
=== null ||
512 $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
516 $this->mFieldData
= [];
523 * Try submitting, with edit token check first
524 * @return Status|bool
526 public function tryAuthorizedSubmit() {
530 if ( $this->mFormIdentifier
=== null ) {
533 $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
;
537 if ( $this->getMethod() !== 'post' ) {
538 $tokenOkay = true; // no session check needed
539 } elseif ( $this->getRequest()->wasPosted() ) {
540 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
541 if ( $this->getUser()->isLoggedIn() ||
$editToken !== null ) {
542 // Session tokens for logged-out users have no security value.
543 // However, if the user gave one, check it in order to give a nice
544 // "session expired" error instead of "permission denied" or such.
545 $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt
);
551 if ( $tokenOkay && $identOkay ) {
552 $this->mWasSubmitted
= true;
553 $result = $this->trySubmit();
560 * The here's-one-I-made-earlier option: do the submission if
561 * posted, or display the form with or without funky validation
563 * @return bool|Status Whether submission was successful.
565 public function show() {
566 $this->prepareForm();
568 $result = $this->tryAuthorizedSubmit();
569 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
573 $this->displayForm( $result );
579 * Same as self::show with the difference, that the form will be
580 * added to the output, no matter, if the validation was good or not.
581 * @return bool|Status Whether submission was successful.
583 public function showAlways() {
584 $this->prepareForm();
586 $result = $this->tryAuthorizedSubmit();
588 $this->displayForm( $result );
594 * Validate all the fields, and call the submission callback
595 * function if everything is kosher.
596 * @throws MWException
597 * @return bool|string|array|Status
598 * - Bool true or a good Status object indicates success,
599 * - Bool false indicates no submission was attempted,
600 * - Anything else indicates failure. The value may be a fatal Status
601 * object, an HTML string, or an array of arrays (message keys and
602 * params) or strings (message keys)
604 public function trySubmit() {
606 $hoistedErrors = Status
::newGood();
607 if ( $this->mValidationErrorMessage
) {
608 foreach ( (array)$this->mValidationErrorMessage
as $error ) {
609 $hoistedErrors->fatal( ...$error );
612 $hoistedErrors->fatal( 'htmlform-invalid-input' );
615 $this->mWasSubmitted
= true;
617 # Check for cancelled submission
618 foreach ( $this->mFlatFields
as $fieldname => $field ) {
619 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
622 if ( $field->cancelSubmit( $this->mFieldData
[$fieldname], $this->mFieldData
) ) {
623 $this->mWasSubmitted
= false;
628 # Check for validation
629 foreach ( $this->mFlatFields
as $fieldname => $field ) {
630 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
633 if ( $field->isHidden( $this->mFieldData
) ) {
636 $res = $field->validate( $this->mFieldData
[$fieldname], $this->mFieldData
);
637 if ( $res !== true ) {
639 if ( $res !== false && !$field->canDisplayErrors() ) {
640 if ( is_string( $res ) ) {
641 $hoistedErrors->fatal( 'rawmessage', $res );
643 $hoistedErrors->fatal( $res );
650 return $hoistedErrors;
653 $callback = $this->mSubmitCallback
;
654 if ( !is_callable( $callback ) ) {
655 throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
656 'setSubmitCallback() to set one.' );
659 $data = $this->filterDataForSubmit( $this->mFieldData
);
661 $res = call_user_func( $callback, $data, $this );
662 if ( $res === false ) {
663 $this->mWasSubmitted
= false;
670 * Test whether the form was considered to have been submitted or not, i.e.
671 * whether the last call to tryAuthorizedSubmit or trySubmit returned
674 * This will return false until HTMLForm::tryAuthorizedSubmit or
675 * HTMLForm::trySubmit is called.
680 public function wasSubmitted() {
681 return $this->mWasSubmitted
;
685 * Set a callback to a function to do something with the form
686 * once it's been successfully validated.
688 * @param callable $cb The function will be passed the output from
689 * HTMLForm::filterDataForSubmit and this HTMLForm object, and must
690 * return as documented for HTMLForm::trySubmit
692 * @return HTMLForm $this for chaining calls (since 1.20)
694 public function setSubmitCallback( $cb ) {
695 $this->mSubmitCallback
= $cb;
701 * Set a message to display on a validation error.
703 * @param string|array $msg String or Array of valid inputs to wfMessage()
704 * (so each entry can be either a String or Array)
706 * @return HTMLForm $this for chaining calls (since 1.20)
708 public function setValidationErrorMessage( $msg ) {
709 $this->mValidationErrorMessage
= $msg;
715 * Set the introductory message, overwriting any existing message.
717 * @param string $msg Complete text of message to display
719 * @return HTMLForm $this for chaining calls (since 1.20)
721 public function setIntro( $msg ) {
722 $this->setPreText( $msg );
728 * Set the introductory message HTML, overwriting any existing message.
731 * @param string $msg Complete HTML of message to display
733 * @return HTMLForm $this for chaining calls (since 1.20)
735 public function setPreText( $msg ) {
742 * Add HTML to introductory message.
744 * @param string $msg Complete HTML of message to display
746 * @return HTMLForm $this for chaining calls (since 1.20)
748 public function addPreText( $msg ) {
755 * Get the introductory message HTML.
761 public function getPreText() {
766 * Add HTML to the header, inside the form.
768 * @param string $msg Additional HTML to display in header
769 * @param string|null $section The section to add the header to
771 * @return HTMLForm $this for chaining calls (since 1.20)
773 public function addHeaderText( $msg, $section = null ) {
774 if ( $section === null ) {
775 $this->mHeader
.= $msg;
777 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
778 $this->mSectionHeaders
[$section] = '';
780 $this->mSectionHeaders
[$section] .= $msg;
787 * Set header text, inside the form.
790 * @param string $msg Complete HTML of header to display
791 * @param string|null $section The section to add the header to
793 * @return HTMLForm $this for chaining calls (since 1.20)
795 public function setHeaderText( $msg, $section = null ) {
796 if ( $section === null ) {
797 $this->mHeader
= $msg;
799 $this->mSectionHeaders
[$section] = $msg;
808 * @param string|null $section The section to get the header text for
810 * @return string HTML
812 public function getHeaderText( $section = null ) {
813 if ( $section === null ) {
814 return $this->mHeader
;
816 return $this->mSectionHeaders
[$section] ??
'';
821 * Add footer text, inside the form.
823 * @param string $msg Complete text of message to display
824 * @param string|null $section The section to add the footer text to
826 * @return HTMLForm $this for chaining calls (since 1.20)
828 public function addFooterText( $msg, $section = null ) {
829 if ( $section === null ) {
830 $this->mFooter
.= $msg;
832 if ( !isset( $this->mSectionFooters
[$section] ) ) {
833 $this->mSectionFooters
[$section] = '';
835 $this->mSectionFooters
[$section] .= $msg;
842 * Set footer text, inside the form.
845 * @param string $msg Complete text of message to display
846 * @param string|null $section The section to add the footer text to
848 * @return HTMLForm $this for chaining calls (since 1.20)
850 public function setFooterText( $msg, $section = null ) {
851 if ( $section === null ) {
852 $this->mFooter
= $msg;
854 $this->mSectionFooters
[$section] = $msg;
863 * @param string|null $section The section to get the footer text for
867 public function getFooterText( $section = null ) {
868 if ( $section === null ) {
869 return $this->mFooter
;
871 return $this->mSectionFooters
[$section] ??
'';
876 * Add text to the end of the display.
878 * @param string $msg Complete text of message to display
880 * @return HTMLForm $this for chaining calls (since 1.20)
882 public function addPostText( $msg ) {
883 $this->mPost
.= $msg;
889 * Set text at the end of the display.
891 * @param string $msg Complete text of message to display
893 * @return HTMLForm $this for chaining calls (since 1.20)
895 public function setPostText( $msg ) {
902 * Add a hidden field to the output
904 * @param string $name Field name. This will be used exactly as entered
905 * @param string $value Field value
906 * @param array $attribs
908 * @return HTMLForm $this for chaining calls (since 1.20)
910 public function addHiddenField( $name, $value, array $attribs = [] ) {
911 $attribs +
= [ 'name' => $name ];
912 $this->mHiddenFields
[] = [ $value, $attribs ];
918 * Add an array of hidden fields to the output
922 * @param array $fields Associative array of fields to add;
923 * mapping names to their values
925 * @return HTMLForm $this for chaining calls
927 public function addHiddenFields( array $fields ) {
928 foreach ( $fields as $name => $value ) {
929 $this->mHiddenFields
[] = [ $value, [ 'name' => $name ] ];
936 * Add a button to the form
938 * @since 1.27 takes an array as shown. Earlier versions accepted
939 * 'name', 'value', 'id', and 'attribs' as separate parameters in that
941 * @note Custom labels ('label', 'label-message', 'label-raw') are not
942 * supported for IE6 and IE7 due to bugs in those browsers. If detected,
943 * they will be served buttons using 'value' as the button label.
944 * @param array $data Data to define the button:
945 * - name: (string) Button name.
946 * - value: (string) Button value.
947 * - label-message: (string, optional) Button label message key to use
948 * instead of 'value'. Overrides 'label' and 'label-raw'.
949 * - label: (string, optional) Button label text to use instead of
950 * 'value'. Overrides 'label-raw'.
951 * - label-raw: (string, optional) Button label HTML to use instead of
953 * - id: (string, optional) DOM id for the button.
954 * - attribs: (array, optional) Additional HTML attributes.
955 * - flags: (string|string[], optional) OOUI flags.
956 * - framed: (boolean=true, optional) OOUI framed attribute.
957 * @return HTMLForm $this for chaining calls (since 1.20)
959 public function addButton( $data ) {
960 if ( !is_array( $data ) ) {
961 $args = func_get_args();
962 if ( count( $args ) < 2 ||
count( $args ) > 4 ) {
963 throw new InvalidArgumentException(
964 'Incorrect number of arguments for deprecated calling style'
970 'id' => $args[2] ??
null,
971 'attribs' => $args[3] ??
null,
974 if ( !isset( $data['name'] ) ) {
975 throw new InvalidArgumentException( 'A name is required' );
977 if ( !isset( $data['value'] ) ) {
978 throw new InvalidArgumentException( 'A value is required' );
981 $this->mButtons
[] = $data +
[
992 * Set the salt for the edit token.
994 * Only useful when the method is "post".
997 * @param string|array $salt Salt to use
998 * @return HTMLForm $this For chaining calls
1000 public function setTokenSalt( $salt ) {
1001 $this->mTokenSalt
= $salt;
1007 * Display the form (sending to the context's OutputPage object), with an
1008 * appropriate error message or stack of messages, and any validation errors, etc.
1010 * @warning You should call prepareForm() before calling this function.
1011 * Moreover, when doing method chaining this should be the very last method
1012 * call just after prepareForm().
1014 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1016 * @return void Nothing, should be last call
1018 public function displayForm( $submitResult ) {
1019 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1023 * Returns the raw HTML generated by the form
1025 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1027 * @return string HTML
1028 * @return-taint escaped
1030 public function getHTML( $submitResult ) {
1031 # For good measure (it is the default)
1032 $this->getOutput()->preventClickjacking();
1033 $this->getOutput()->addModules( 'mediawiki.htmlform' );
1034 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1037 . $this->getErrorsOrWarnings( $submitResult, 'error' )
1038 . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1039 . $this->getHeaderText()
1041 . $this->getHiddenFields()
1042 . $this->getButtons()
1043 . $this->getFooterText();
1045 $html = $this->wrapForm( $html );
1047 return '' . $this->mPre
. $html . $this->mPost
;
1051 * Get HTML attributes for the `<form>` tag.
1054 protected function getFormAttributes() {
1055 # Use multipart/form-data
1056 $encType = $this->mUseMultipart
1057 ?
'multipart/form-data'
1058 : 'application/x-www-form-urlencoded';
1061 'class' => 'mw-htmlform',
1062 'action' => $this->getAction(),
1063 'method' => $this->getMethod(),
1064 'enctype' => $encType,
1067 $attribs['id'] = $this->mId
;
1069 if ( is_string( $this->mAutocomplete
) ) {
1070 $attribs['autocomplete'] = $this->mAutocomplete
;
1072 if ( $this->mName
) {
1073 $attribs['name'] = $this->mName
;
1075 if ( $this->needsJSForHtml5FormValidation() ) {
1076 $attribs['novalidate'] = true;
1082 * Wrap the form innards in an actual "<form>" element
1084 * @param string $html HTML contents to wrap.
1086 * @return string Wrapped HTML.
1088 public function wrapForm( $html ) {
1089 # Include a <fieldset> wrapper for style, if requested.
1090 if ( $this->mWrapperLegend
!== false ) {
1091 $legend = is_string( $this->mWrapperLegend
) ?
$this->mWrapperLegend
: false;
1092 $html = Xml
::fieldset( $legend, $html );
1095 return Html
::rawElement(
1097 $this->getFormAttributes(),
1103 * Get the hidden fields that should go inside the form.
1104 * @return string HTML.
1106 public function getHiddenFields() {
1108 if ( $this->mFormIdentifier
!== null ) {
1109 $html .= Html
::hidden(
1111 $this->mFormIdentifier
1114 if ( $this->getMethod() === 'post' ) {
1115 $html .= Html
::hidden(
1117 $this->getUser()->getEditToken( $this->mTokenSalt
),
1118 [ 'id' => 'wpEditToken' ]
1120 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1123 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1124 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1125 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1128 foreach ( $this->mHiddenFields
as $data ) {
1129 list( $value, $attribs ) = $data;
1130 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
1137 * Get the submit and (potentially) reset buttons.
1138 * @return string HTML.
1140 public function getButtons() {
1142 $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1144 if ( $this->mShowSubmit
) {
1147 if ( isset( $this->mSubmitID
) ) {
1148 $attribs['id'] = $this->mSubmitID
;
1151 if ( isset( $this->mSubmitName
) ) {
1152 $attribs['name'] = $this->mSubmitName
;
1155 if ( isset( $this->mSubmitTooltip
) ) {
1156 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
1159 $attribs['class'] = [ 'mw-htmlform-submit' ];
1161 if ( $useMediaWikiUIEverywhere ) {
1162 foreach ( $this->mSubmitFlags
as $flag ) {
1163 $attribs['class'][] = 'mw-ui-' . $flag;
1165 $attribs['class'][] = 'mw-ui-button';
1168 $buttons .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1171 if ( $this->mShowReset
) {
1172 $buttons .= Html
::element(
1176 'value' => $this->msg( 'htmlform-reset' )->text(),
1177 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1182 if ( $this->mShowCancel
) {
1183 $target = $this->mCancelTarget ?
: Title
::newMainPage();
1184 if ( $target instanceof Title
) {
1185 $target = $target->getLocalURL();
1187 $buttons .= Html
::element(
1190 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1193 $this->msg( 'cancel' )->text()
1197 // IE<8 has bugs with <button>, so we'll need to avoid them.
1198 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1200 foreach ( $this->mButtons
as $button ) {
1203 'name' => $button['name'],
1204 'value' => $button['value']
1207 if ( isset( $button['label-message'] ) ) {
1208 $label = $this->getMessage( $button['label-message'] )->parse();
1209 } elseif ( isset( $button['label'] ) ) {
1210 $label = htmlspecialchars( $button['label'] );
1211 } elseif ( isset( $button['label-raw'] ) ) {
1212 $label = $button['label-raw'];
1214 $label = htmlspecialchars( $button['value'] );
1217 if ( $button['attribs'] ) {
1218 $attrs +
= $button['attribs'];
1221 if ( isset( $button['id'] ) ) {
1222 $attrs['id'] = $button['id'];
1225 if ( $useMediaWikiUIEverywhere ) {
1226 $attrs['class'] = isset( $attrs['class'] ) ?
(array)$attrs['class'] : [];
1227 $attrs['class'][] = 'mw-ui-button';
1231 $buttons .= Html
::element( 'input', $attrs ) . "\n";
1233 $buttons .= Html
::rawElement( 'button', $attrs, $label ) . "\n";
1241 return Html
::rawElement( 'span',
1242 [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1246 * Get the whole body of the form.
1249 public function getBody() {
1250 return $this->displaySection( $this->mFieldTree
, $this->mTableId
);
1254 * Format and display an error message stack.
1256 * @param string|array|Status $errors
1258 * @deprecated since 1.28, use getErrorsOrWarnings() instead
1262 public function getErrors( $errors ) {
1263 wfDeprecated( __METHOD__
);
1264 return $this->getErrorsOrWarnings( $errors, 'error' );
1268 * Returns a formatted list of errors or warnings from the given elements.
1270 * @param string|array|Status $elements The set of errors/warnings to process.
1271 * @param string $elementsType Should warnings or errors be returned. This is meant
1272 * for Status objects, all other valid types are always considered as errors.
1275 public function getErrorsOrWarnings( $elements, $elementsType ) {
1276 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1277 throw new DomainException( $elementsType . ' is not a valid type.' );
1279 $elementstr = false;
1280 if ( $elements instanceof Status
) {
1281 list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1282 $status = $elementsType === 'error' ?
$errorStatus : $warningStatus;
1283 if ( $status->isGood() ) {
1286 $elementstr = $this->getOutput()->parseAsInterface(
1287 $status->getWikiText()
1290 } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1291 $elementstr = $this->formatErrors( $elements );
1292 } elseif ( $elementsType === 'error' ) {
1293 $elementstr = $elements;
1297 ? Html
::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1302 * Format a stack of error messages into a single HTML string
1304 * @param array $errors Array of message keys/values
1306 * @return string HTML, a "<ul>" list of errors
1308 public function formatErrors( $errors ) {
1311 foreach ( $errors as $error ) {
1312 $errorstr .= Html
::rawElement(
1315 $this->getMessage( $error )->parse()
1319 $errorstr = Html
::rawElement( 'ul', [], $errorstr );
1325 * Set the text for the submit button
1327 * @param string $t Plaintext
1329 * @return HTMLForm $this for chaining calls (since 1.20)
1331 public function setSubmitText( $t ) {
1332 $this->mSubmitText
= $t;
1338 * Identify that the submit button in the form has a destructive action
1341 * @return HTMLForm $this for chaining calls (since 1.28)
1343 public function setSubmitDestructive() {
1344 $this->mSubmitFlags
= [ 'destructive', 'primary' ];
1350 * Identify that the submit button in the form has a progressive action
1352 * @deprecated since 1.32, No need to call. Submit button already
1353 * has a progressive action form.
1355 * @return HTMLForm $this for chaining calls (since 1.28)
1357 public function setSubmitProgressive() {
1358 wfDeprecated( __METHOD__
, '1.32' );
1359 $this->mSubmitFlags
= [ 'progressive', 'primary' ];
1365 * Set the text for the submit button to a message
1368 * @param string|Message $msg Message key or Message object
1370 * @return HTMLForm $this for chaining calls (since 1.20)
1372 public function setSubmitTextMsg( $msg ) {
1373 if ( !$msg instanceof Message
) {
1374 $msg = $this->msg( $msg );
1376 $this->setSubmitText( $msg->text() );
1382 * Get the text for the submit button, either customised or a default.
1385 public function getSubmitText() {
1386 return $this->mSubmitText ?
: $this->msg( 'htmlform-submit' )->text();
1390 * @param string $name Submit button name
1392 * @return HTMLForm $this for chaining calls (since 1.20)
1394 public function setSubmitName( $name ) {
1395 $this->mSubmitName
= $name;
1401 * @param string $name Tooltip for the submit button
1403 * @return HTMLForm $this for chaining calls (since 1.20)
1405 public function setSubmitTooltip( $name ) {
1406 $this->mSubmitTooltip
= $name;
1412 * Set the id for the submit button.
1416 * @todo FIXME: Integrity of $t is *not* validated
1417 * @return HTMLForm $this for chaining calls (since 1.20)
1419 public function setSubmitID( $t ) {
1420 $this->mSubmitID
= $t;
1426 * Set an internal identifier for this form. It will be submitted as a hidden form field, allowing
1427 * HTMLForm to determine whether the form was submitted (or merely viewed). Setting this serves
1430 * - If you use two or more forms on one page, it allows HTMLForm to identify which of the forms
1431 * was submitted, and not attempt to validate the other ones.
1432 * - If you use checkbox or multiselect fields inside a form using the GET method, it allows
1433 * HTMLForm to distinguish between the initial page view and a form submission with all
1434 * checkboxes or select options unchecked.
1437 * @param string $ident
1440 public function setFormIdentifier( $ident ) {
1441 $this->mFormIdentifier
= $ident;
1447 * Stop a default submit button being shown for this form. This implies that an
1448 * alternate submit method must be provided manually.
1452 * @param bool $suppressSubmit Set to false to re-enable the button again
1454 * @return HTMLForm $this for chaining calls
1456 public function suppressDefaultSubmit( $suppressSubmit = true ) {
1457 $this->mShowSubmit
= !$suppressSubmit;
1463 * Show a cancel button (or prevent it). The button is not shown by default.
1465 * @return HTMLForm $this for chaining calls
1468 public function showCancel( $show = true ) {
1469 $this->mShowCancel
= $show;
1474 * Sets the target where the user is redirected to after clicking cancel.
1475 * @param Title|string $target Target as a Title object or an URL
1476 * @return HTMLForm $this for chaining calls
1479 public function setCancelTarget( $target ) {
1480 $this->mCancelTarget
= $target;
1485 * Set the id of the \<table\> or outermost \<div\> element.
1489 * @param string $id New value of the id attribute, or "" to remove
1491 * @return HTMLForm $this for chaining calls
1493 public function setTableId( $id ) {
1494 $this->mTableId
= $id;
1500 * @param string $id DOM id for the form
1502 * @return HTMLForm $this for chaining calls (since 1.20)
1504 public function setId( $id ) {
1511 * @param string $name 'name' attribute for the form
1512 * @return HTMLForm $this for chaining calls
1514 public function setName( $name ) {
1515 $this->mName
= $name;
1521 * Prompt the whole form to be wrapped in a "<fieldset>", with
1522 * this text as its "<legend>" element.
1524 * @param string|bool $legend If false, no wrapper or legend will be displayed.
1525 * If true, a wrapper will be displayed, but no legend.
1526 * If a string, a wrapper will be displayed with that string as a legend.
1527 * The string will be escaped before being output (this doesn't support HTML).
1529 * @return HTMLForm $this for chaining calls (since 1.20)
1531 public function setWrapperLegend( $legend ) {
1532 $this->mWrapperLegend
= $legend;
1538 * Prompt the whole form to be wrapped in a "<fieldset>", with
1539 * this message as its "<legend>" element.
1542 * @param string|Message $msg Message key or Message object
1544 * @return HTMLForm $this for chaining calls (since 1.20)
1546 public function setWrapperLegendMsg( $msg ) {
1547 if ( !$msg instanceof Message
) {
1548 $msg = $this->msg( $msg );
1550 $this->setWrapperLegend( $msg->text() );
1556 * Set the prefix for various default messages
1557 * @todo Currently only used for the "<fieldset>" legend on forms
1558 * with multiple sections; should be used elsewhere?
1562 * @return HTMLForm $this for chaining calls (since 1.20)
1564 public function setMessagePrefix( $p ) {
1565 $this->mMessagePrefix
= $p;
1571 * Set the title for form submission
1573 * @param Title $t Title of page the form is on/should be posted to
1575 * @return HTMLForm $this for chaining calls (since 1.20)
1577 public function setTitle( $t ) {
1587 public function getTitle() {
1588 return $this->mTitle
=== false
1589 ?
$this->getContext()->getTitle()
1594 * Set the method used to submit the form
1596 * @param string $method
1598 * @return HTMLForm $this for chaining calls (since 1.20)
1600 public function setMethod( $method = 'post' ) {
1601 $this->mMethod
= strtolower( $method );
1607 * @return string Always lowercase
1609 public function getMethod() {
1610 return $this->mMethod
;
1614 * Wraps the given $section into an user-visible fieldset.
1616 * @param string $legend Legend text for the fieldset
1617 * @param string $section The section content in plain Html
1618 * @param array $attributes Additional attributes for the fieldset
1619 * @param bool $isRoot Section is at the root of the tree
1620 * @return string The fieldset's Html
1622 protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1623 return Xml
::fieldset( $legend, $section, $attributes ) . "\n";
1629 * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1631 * @param string $sectionName ID attribute of the "<table>" tag for this
1632 * section, ignored if empty.
1633 * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1634 * each subsection, ignored if empty.
1635 * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1636 * @throws LogicException When called on uninitialized field data, e.g. When
1637 * HTMLForm::displayForm was called without calling HTMLForm::prepareForm
1642 public function displaySection( $fields,
1644 $fieldsetIDPrefix = '',
1645 &$hasUserVisibleFields = false
1647 if ( $this->mFieldData
=== null ) {
1648 throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1649 . 'You probably called displayForm() without calling prepareForm() first.' );
1652 $displayFormat = $this->getDisplayFormat();
1655 $subsectionHtml = '';
1658 // Conveniently, PHP method names are case-insensitive.
1659 // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1660 $getFieldHtmlMethod = $displayFormat === 'table' ?
'getTableRow' : ( 'get' . $displayFormat );
1662 foreach ( $fields as $key => $value ) {
1663 if ( $value instanceof HTMLFormField
) {
1664 $v = array_key_exists( $key, $this->mFieldData
)
1665 ?
$this->mFieldData
[$key]
1666 : $value->getDefault();
1668 $retval = $value->$getFieldHtmlMethod( $v );
1670 // check, if the form field should be added to
1672 if ( $value->hasVisibleOutput() ) {
1675 $labelValue = trim( $value->getLabel() );
1676 if ( $labelValue !== "\u{00A0}" && $labelValue !== ' ' && $labelValue !== '' ) {
1680 $hasUserVisibleFields = true;
1682 } elseif ( is_array( $value ) ) {
1683 $subsectionHasVisibleFields = false;
1685 $this->displaySection( $value,
1687 "$fieldsetIDPrefix$key-",
1688 $subsectionHasVisibleFields );
1691 if ( $subsectionHasVisibleFields === true ) {
1692 // Display the section with various niceties.
1693 $hasUserVisibleFields = true;
1695 $legend = $this->getLegend( $key );
1697 $section = $this->getHeaderText( $key ) .
1699 $this->getFooterText( $key );
1702 if ( $fieldsetIDPrefix ) {
1703 $attributes['id'] = Sanitizer
::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1705 $subsectionHtml .= $this->wrapFieldSetSection(
1706 $legend, $section, $attributes, $fields === $this->mFieldTree
1709 // Just return the inputs, nothing fancy.
1710 $subsectionHtml .= $section;
1715 $html = $this->formatSection( $html, $sectionName, $hasLabel );
1717 if ( $subsectionHtml ) {
1718 if ( $this->mSubSectionBeforeFields
) {
1719 return $subsectionHtml . "\n" . $html;
1721 return $html . "\n" . $subsectionHtml;
1729 * Put a form section together from the individual fields' HTML, merging it and wrapping.
1730 * @param array $fieldsHtml
1731 * @param string $sectionName
1732 * @param bool $anyFieldHasLabel
1733 * @return string HTML
1735 protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1736 if ( !$fieldsHtml ) {
1737 // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1738 // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1742 $displayFormat = $this->getDisplayFormat();
1743 $html = implode( '', $fieldsHtml );
1745 if ( $displayFormat === 'raw' ) {
1751 if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1752 $classes[] = 'mw-htmlform-nolabel';
1756 'class' => implode( ' ', $classes ),
1759 if ( $sectionName ) {
1760 $attribs['id'] = Sanitizer
::escapeIdForAttribute( $sectionName );
1763 if ( $displayFormat === 'table' ) {
1764 return Html
::rawElement( 'table',
1766 Html
::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1767 } elseif ( $displayFormat === 'inline' ) {
1768 return Html
::rawElement( 'span', $attribs, "\n$html\n" );
1770 return Html
::rawElement( 'div', $attribs, "\n$html\n" );
1775 * Construct the form fields from the Descriptor array
1777 public function loadData() {
1780 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1781 $request = $this->getRequest();
1782 if ( $field->skipLoadData( $request ) ) {
1784 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1785 $fieldData[$fieldname] = $field->getDefault();
1787 $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1792 foreach ( $fieldData as $name => &$value ) {
1793 $field = $this->mFlatFields
[$name];
1794 $value = $field->filter( $value, $this->mFlatFields
);
1797 $this->mFieldData
= $fieldData;
1801 * Stop a reset button being shown for this form
1803 * @param bool $suppressReset Set to false to re-enable the button again
1805 * @return HTMLForm $this for chaining calls (since 1.20)
1807 public function suppressReset( $suppressReset = true ) {
1808 $this->mShowReset
= !$suppressReset;
1814 * Overload this if you want to apply special filtration routines
1815 * to the form as a whole, after it's submitted but before it's
1818 * @param array $data
1822 public function filterDataForSubmit( $data ) {
1827 * Get a string to go in the "<legend>" of a section fieldset.
1828 * Override this if you want something more complicated.
1830 * @param string $key
1832 * @return string Plain text (not HTML-escaped)
1834 public function getLegend( $key ) {
1835 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1839 * Set the value for the action attribute of the form.
1840 * When set to false (which is the default state), the set title is used.
1844 * @param string|bool $action
1846 * @return HTMLForm $this for chaining calls (since 1.20)
1848 public function setAction( $action ) {
1849 $this->mAction
= $action;
1855 * Get the value for the action attribute of the form.
1861 public function getAction() {
1862 // If an action is alredy provided, return it
1863 if ( $this->mAction
!== false ) {
1864 return $this->mAction
;
1867 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1868 // Check whether we are in GET mode and the ArticlePath contains a "?"
1869 // meaning that getLocalURL() would return something like "index.php?title=...".
1870 // As browser remove the query string before submitting GET forms,
1871 // it means that the title would be lost. In such case use wfScript() instead
1872 // and put title in an hidden field (see getHiddenFields()).
1873 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1877 return $this->getTitle()->getLocalURL();
1881 * Set the value for the autocomplete attribute of the form. A typical value is "off".
1882 * When set to null (which is the default state), the attribute get not set.
1886 * @param string|null $autocomplete
1888 * @return HTMLForm $this for chaining calls
1890 public function setAutocomplete( $autocomplete ) {
1891 $this->mAutocomplete
= $autocomplete;
1897 * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1898 * name + parameters array) into a Message.
1899 * @param mixed $value
1902 protected function getMessage( $value ) {
1903 return Message
::newFromSpecifier( $value )->setContext( $this );
1907 * Whether this form, with its current fields, requires the user agent to have JavaScript enabled
1908 * for the client-side HTML5 form validation to work correctly. If this function returns true, a
1909 * 'novalidate' attribute will be added on the `<form>` element. It will be removed if the user
1910 * agent has JavaScript support, in htmlform.js.
1915 public function needsJSForHtml5FormValidation() {
1916 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1917 if ( $field->needsJSForHtml5FormValidation() ) {